GET Assets?assetTypeId={assetTypeId}&assetGroupId={assetGroupId}&parentAssetId={parentAssetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves assets for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
| assetGroupId |
Id of the asset group |
globally unique identifier |
None. |
| parentAssetId |
Id of the parent asset |
globally unique identifier |
None. |
| take |
Number of assets to retrieve. Default is all assets |
integer |
None. |
| skip |
Number of assets to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the assets before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of assets.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Asset |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"AssetId": "e0dc77db-884b-4b8d-9d47-33e827c7914a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3834f12a-4284-4f17-8b16-d7e939387b60",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08c5a67b-1f79-4284-b586-056cde5b9a39",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c35a4c43-2e6f-42c0-8b99-7c942ff04377",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"MeasurementValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "45b8e163-a049-44c7-8f6a-d2e147b678ca",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a1f8ef8b-e6ea-4d40-905e-0c1a0fed69d3",
"EffectiveDate": "2024-04-28T12:14:01.8542727-07:00",
"StateType": {
"StateTypeId": "efe10ad8-e320-4028-bfd2-7600f09d6ea8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3834f12a-4284-4f17-8b16-d7e939387b60",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08c5a67b-1f79-4284-b586-056cde5b9a39",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6a5c43c1-5523-4508-ba92-2bfba4f73ba9",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "11fa5b36-03d3-4e30-b9de-83d88eeb9183",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0a56d860-4011-47c5-98fe-20b248d150c9",
"EffectiveDate": "2024-04-28T12:14:01.8542727-07:00",
"StatusType": {
"StatusTypeId": "7169776c-520a-4694-951c-0db46c29953e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3834f12a-4284-4f17-8b16-d7e939387b60",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08c5a67b-1f79-4284-b586-056cde5b9a39",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e76eeaa8-798a-4b50-870e-2e7969bdc0e9",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6d6322b9-3616-4565-993b-20f68fa540d0",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "63162804-9e9f-4191-badd-0399cd6c276a",
"EffectiveDate": "2024-04-28T12:14:01.8542727-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3f8ec624-6a49-4b98-9762-94c943b31704",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9ed6d2f6-d663-4000-a3fe-f2e74645acaa",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f6f4635b-8b47-43e8-af21-e9de7b26cb11",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"MeasurementValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17e6cb40-7de0-4145-bca9-c87388f93899",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
{
"AssetId": "e0dc77db-884b-4b8d-9d47-33e827c7914a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3834f12a-4284-4f17-8b16-d7e939387b60",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08c5a67b-1f79-4284-b586-056cde5b9a39",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c35a4c43-2e6f-42c0-8b99-7c942ff04377",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"MeasurementValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "45b8e163-a049-44c7-8f6a-d2e147b678ca",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a1f8ef8b-e6ea-4d40-905e-0c1a0fed69d3",
"EffectiveDate": "2024-04-28T12:14:01.8542727-07:00",
"StateType": {
"StateTypeId": "efe10ad8-e320-4028-bfd2-7600f09d6ea8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3834f12a-4284-4f17-8b16-d7e939387b60",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08c5a67b-1f79-4284-b586-056cde5b9a39",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6a5c43c1-5523-4508-ba92-2bfba4f73ba9",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "11fa5b36-03d3-4e30-b9de-83d88eeb9183",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0a56d860-4011-47c5-98fe-20b248d150c9",
"EffectiveDate": "2024-04-28T12:14:01.8542727-07:00",
"StatusType": {
"StatusTypeId": "7169776c-520a-4694-951c-0db46c29953e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3834f12a-4284-4f17-8b16-d7e939387b60",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08c5a67b-1f79-4284-b586-056cde5b9a39",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e76eeaa8-798a-4b50-870e-2e7969bdc0e9",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6d6322b9-3616-4565-993b-20f68fa540d0",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "63162804-9e9f-4191-badd-0399cd6c276a",
"EffectiveDate": "2024-04-28T12:14:01.8542727-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3f8ec624-6a49-4b98-9762-94c943b31704",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9ed6d2f6-d663-4000-a3fe-f2e74645acaa",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f6f4635b-8b47-43e8-af21-e9de7b26cb11",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"MeasurementValueNeededDate": "2024-04-28T12:14:01.8542727-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17e6cb40-7de0-4145-bca9-c87388f93899",
"CreateDate": "2024-04-28T12:14:01.8542727-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T12:14:01.8542727-07:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}